BanAPI是一个Minecraft服务端插件，用于与外部封禁API集成，实现玩家封禁信息的统一管理。该插件支持本地API和公共封禁数据库两种方式，可以有效防止不良玩家进入服务器。
BanAPI 是一个 Minecraft 服务端插件，用于与外部封禁API集成，实现玩家封禁信息的统一管理。该插件支持本地API和公共封禁数据库两种方式，可以有效防止不良玩家进入服务器。
| 权限节点 | 描述 | 默认值 |
|---|---|---|
banapi.getapi |
允许查看BanAPI的API信息 | OP |
banapi.admin |
允许管理BanAPI的封禁记录 | OP |
banapi.publicban |
允许查询公共封禁API的信息 | OP |
banapi.alerts |
允许接收公共封禁API的警告消息 | OP |
banapi.getapi（默认为 OP）/getapibanapi.admin（默认为 OP）list - 显示所有封禁列表stats - 显示封禁统计信息ban <玩家名> <原因> <管理员> [永久] [时长] - 添加封禁记录release <ID> - 解除指定ID的封禁banapi.publicban（默认为 OP）list - 显示公共封禁列表stats - 显示公共封禁统计信息check <玩家名> - 检查玩家是否在公共封禁列表中checkip <IP地址> - 检查IP是否在公共封禁列表中# 查看API信息
/getapi
# 查看封禁列表
/banapi list
# 添加封禁记录
/banapi ban Steve 使用作弊客户端 Admin true
# 解除封禁
/banapi release 12345
# 检查公共封禁
/publicban check Alex
# 检查IP封禁
/publicban checkip 192.168.1.1
# BanAPI 插件配置
api:
# API服务器地址
url: "http://localhost:5000"
# API访问密钥
key: "bans-api-secret-key-12345"
# BungeeCord支持配置
bungee:
# 是否启用BungeeCord支持
enabled: false
# BungeeCord通道名称
channel: "BungeeCord"
# 公共API配置
public-api:
# 是否启用公共API检查
enabled: true
# 警告消息格式
warning-format: |
§c[BanAPI预警] §e玩家 {nickname} §c在公共封禁列表中
§7IP: §f{ip}
§7原因: §f{reason}
§7封禁时间: §f{timestamp}
# 是否记录警告日志
log-warnings: true
# 自动更新设置 (秒)
update-interval: 60
# 封禁广播配置
broadcast:
enabled: true
format: "§c[封禁公告] 玩家 §e{nickname} §c已被管理员 §e{admin} §c封禁\n§7原因: §f{reason}\n§7累计封禁数: §f{total}"
# 封禁消息配置
ban-message:
# 玩家被封禁时看到的消息
format: |
§4§l您已被服务器封禁!
§c▶ §f原因: §e{reason}
§c▶ §f管理员: §e{admin}
§c▶ §f封禁时间: §e{startTime}
§c▶ §f封禁类型: §e{banType}
§c▶ §f解封时间: §e{endTime}
§c▶ §f封禁ID: §7#{id}
§7如有异议，请前往discord.gg/xxxxx
§7或填写申诉表单https:xxxxx
| 占位符 | 描述 |
|---|---|
{nickname} |
被封禁玩家的昵称 |
{admin} |
执行封禁的管理员 |
{reason} |
封禁原因 |
{total} |
总封禁数量 |
| 占位符 | 描述 |
|---|---|
{id} |
封禁记录ID |
{reason} |
封禁原因 |
{admin} |
执行封禁的管理员 |
{startTime} |
封禁开始时间 |
{endTime} |
封禁结束时间 |
{banType} |
封禁类型（永久/临时） |
{isPermanent} |
是否永久封禁 |
| 占位符 | 描述 |
|---|---|
{nickname} |
玩家昵称 |
{ip} |
玩家IP地址 |
{reason} |
封禁原因 |
{timestamp} |
封禁时间戳 |
# 封禁广播示例
broadcast:
format: "§c[封禁公告] 玩家 §e{nickname} §c已被管理员 §e{admin} §c封禁"
# 封禁消息示例
ban-message:
format: |
§4§l您已被服务器封禁!
§c▶ §f原因: §e{reason}
§c▶ §f管理员: §e{admin}
§c▶ §f封禁ID: §7#{id}
# 警告消息示例
warning-format: |
§c[BanAPI预警] §e玩家 {nickname} §c在公共封禁列表中
§7IP: §f{ip}
§7原因: §f{reason}
插件支持与外部封禁API集成，需要配置以下信息：
插件期望的API返回数据格式：
{
"success": true,
"data": [
{
"id": "12345",
"player": "Steve",
"reason": "使用作弊客户端",
"admin": "Admin",
"startTime": "2024-01-01T00:00:00Z",
"endTime": "2024-12-31T23:59:59Z",
"isPermanent": false
}
]
}
插件包含完善的错误处理机制：
插件支持自己搭建API服务，项目已在GitHub开源：
确保服务器已安装以下依赖：
config.yml 中的API配置重启服务器使配置生效，插件开始工作。
使用 /getapi 命令验证插件是否正确安装。
查看API信息
/getapi
查看封禁列表
/banapi list
查看封禁统计
/banapi stats
添加封禁记录
/banapi ban <玩家名> <原因> <管理员> [永久] [时长]
示例：/banapi ban Steve 使用作弊客户端 Admin true
解除封禁
/banapi release <ID>
示例：/banapi release 12345
检查玩家封禁
/publicban check <玩家名>
示例：/publicban check Alex
检查IP封禁
/publicban checkip <IP地址>
示例：/publicban checkip 192.168.1.1
查看公共封禁列表
/publicban list
查看公共封禁统计
/publicban stats
编辑配置文件
plugins/BanAPI/config.yml重启服务器
玩家登录检查
管理员封禁操作
公共封禁监控
Q: 插件无法连接到API
A: 检查以下设置：
Q: 玩家未被正确封禁
A: 确保：
Q: BungeeCord环境下踢出不生效
A: 确保：
Q: 公共封禁查询不工作
A: 检查：
Q: 封禁消息格式错误
A: 确保：
插件会在控制台输出相关信息，可以通过日志排查问题：
BanAPI插件使用以下技术栈开发：
插件遵循标准的Bukkit插件开发规范，易于维护和扩展。
这个插件为Minecraft服务器提供了强大的封禁管理功能，通过与外部API集成，实现了高效的玩家封禁信息管理，有效提升了服务器的安全性。